Vcenter NamespaceManagement Clusters NCPClusterNetworkInfo

Vcenter NamespaceManagement Clusters NCPClusterNetworkInfo

The Vcenter NamespaceManagement Clusters NCPClusterNetworkInfo schema contains the NSX Container Plugin-specific cluster networking configuration.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "pod_cidrs": [
        {
            "address": "string",
            "prefix": 0
        }
    ],
    "ingress_cidrs": [
        {
            "address": "string",
            "prefix": 0
        }
    ],
    "egress_cidrs": [
        {
            "address": "string",
            "prefix": 0
        }
    ],
    "cluster_distributed_switch": "string",
    "nsx_edge_cluster": "string",
    "default_ingress_tls_certificate": "string",
    "nsx_tier0_gateway": "string",
    "namespace_subnet_prefix": 0,
    "routed_mode": false
}

array of Vcenter NamespaceManagement Ipv4Cidr

pod_cidrs

Required

CIDR blocks from which Kubernetes allocates pod IP addresses.

This property was added in vSphere API 7.0.0.0.

array of Vcenter NamespaceManagement Ipv4Cidr

ingress_cidrs

Required

CIDR blocks from which NSX assigns IP addresses for Kubernetes Ingresses and Kubernetes Services of type LoadBalancer.

This property was added in vSphere API 7.0.0.0.

array of Vcenter NamespaceManagement Ipv4Cidr

egress_cidrs

Required

CIDR blocks from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs.

This property was added in vSphere API 7.0.0.0.

string

cluster_distributed_switch

Required

vSphere Distributed Switch used to connect this cluster.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: vSphereDistributedSwitch. When operations return a value of this schema as a response, the property will be an identifier for the resource type: vSphereDistributedSwitch.

string

nsx_edge_cluster

Required

NSX Edge cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT.

This property was added in vSphere API 7.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXEdgeCluster. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXEdgeCluster.

string

default_ingress_tls_certificate

Required

PEM-encoded x509 certificate used by NSX as a default fallback certificate for Kubernetes Ingress services.

This property was added in vSphere API 7.0.0.0.

string

nsx_tier0_gateway

Optional

NSX Tier0 Gateway used for this Supervisor.

This property was added in vSphere API 7.0.2.0.

This is set when the cluster uses NSX.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXTier0Gateway. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXTier0Gateway.

integer As int64 As int64

namespace_subnet_prefix

Optional

Size of the subnet reserved for namespaces segments.

This property was added in vSphere API 7.0.2.0.

If missing or null, defaults to 28.

boolean

routed_mode

Optional

Routed mode for this Supervisor.

This property was added in vSphere API 7.0.2.0.

If missing or null, defaults to False.